Use the Create Chromatograph button to manually create new FMS Chromatograph Node configurations. When creating new device Nodes, keep in mind the distinction between meters and chromatographs. A chromatograph must return gas quality history. A meter must return gas measurement history, and may optionally return gas quality history.
CygNet Measurement also provides a system command that can automatically create FMS device Nodes in your system. See the following topic for more information about this option.
See Viewing and Editing Chromatograph Node Properties for more information about accessing properties for Chromatograph Nodes that have already been created.
To create a new Chromatograph Node, Open the Nodes menu in FMS Explorer, and then click Create Chromatograph. A series of dialog boxes will appear.
Note: These dialog boxes are the same as dialog boxes that open when you click New FMS Chromatograph on the FMS page of a remote device in the Device Definition Service (DDS), and the same dialog boxes that open when you View Node properties from many context menus in FMS Explorer and the FMS service in CygNet Explorer.
The following tables list and describe property fields found on the Create Chromatograph dialog boxes.
To create a new Chromatograph Node, first define it in the Device Definition Service (DDS).
Enter the following device definition properties to define the new chromatograph device.
| Property | Description |
|---|---|
|
Node ID |
The system-assigned Node ID for the Chromatograph Node. When creating new Chromatograph Nodes, this will indicate NEW. |
|
Enabled |
The Enabled check box indicates whether the chromatograph is enabled or not. An unchecked box does not mean the chromatograph is deleted; all chromatograph settings are saved until you choose to enable it. Default value is Enabled. |
|
Device name |
Type in the name for the Chromatograph Node. Valid characters (maximum of 20) are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. This parameter is required. |
|
Description |
Type in a free-form Description for the chromatograph. This parameter is optional. |
|
Security application |
Enter the security application used to validate users of the Node. Use this setting to control user access, for example, to only give certain users access to particular Chromatograph Nodes. See FMS Security for more information. This parameter is optional. |
|
Sort priority |
Type in the Sort priority number to assign to the Chromatograph Node. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list. Default value is 0. This parameter is optional. |
| Data source options | |
|
Data source |
Select the data source for the chromatograph from the drop-down menu. Options are as follows.
|
|
Polling UIS |
If Polling Engine is your selected Data Source, click … to select the polling UIS for the chromatograph. |
|
Polling facility |
If Polling Engine is your selected Data Source, click … to select the facility polling for the chromatograph. Note: The list provided contains all linked facilities that belong to the FMS Configuration or FMS Legacy Configuration data group corresponding to your data source selection. |
|
Note: The Unit set override parameter is optional. It is provided to give you the ability to override units in cases where GMR data coming into FMS (via the FMS Toolbox) may contain values in units other than the assumed GMR units. In such a case, use this parameter to define the unit set to use instead, and the FMS system will apply the specified unit set to the incoming GMR data See GMR Data Items Units for more information. If used, select a unit set for the system to apply to GMR data, from the options in the drop-down menu. Options in the drop-down menu are populated by the enabled read-only unit sets configured in your system. You may have to create the applicable unit set first. See Configuring Unit Set Definitions for more information. |
|
|
Source data retention |
Enter the maximum time, in number of days, that source data is retained on your flow computer. Retention on most flow computers is 35 days. Default value is 35 days. |
When you are done, click Next > to access the Chromatograph Properties dialog box.
When the Device Definition is complete, configure the Device Properties.
Enter the following chromatograph device properties and supported data types to describe the new device.
| Property | Description |
|---|---|
| Properties | |
|
Device install date (Device time) |
Select the date and time of the installation of the chromatograph using the date and time selectors. When no user-entered value is provided, the default install date value is 36 days prior to Node creation, at 12:00:00 AM. Example The Install Date is the date and time the chromatograph began collecting data. Notes: The Request Missing Data or Request New Data commands will not request data prior to the device install date. Edits to this property can only be applied for the entire span of the Node. An error message will appear if you try to edit this value for a partial span. |
|
Use job schedule start date |
Note: This parameter defines a date used by the Schedule Jobs command for CygNet Dispatch. For more information about the CygNet Dispatch product, contact your Account Manager or CygNet Sales. When using CygNet Dispatch, optionally set this value to define the first possible start date that can be used for job occurrences associated with this Node, when automatically scheduling jobs via the Schedule Jobs command. If used, click the check box to access the date selector, and specify the earliest date from which CygNet Dispatch jobs for this Node can be scheduled. When no user-entered value is provided, the default value is the Device install date. See Schedule Jobs for more information. |
| Supported data
Note: Each of the following properties is read-only once the corresponding data type has been collected for the Node. The properties can only be edited if the device has not yet received the corresponding data, since Node properties must be consistent across their time continuum. Trying to edit a Supported data property, for a device which has already received that type of data, will produce a service error. |
|
|
Gas quality record span |
Click to select the record span at Node creation. If the Data Source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy History or FMS History (periodic quality). Record span options are as follows.
This property is required. |
|
Configuration |
If the device supports configuration data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Configuration or FMS Configuration. This property is optional. |
|
Events |
If the device supports event data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Events or FMS Events. This property is optional. |
|
Alarms |
If the device supports alarm data, click to select the check box. If the Data source is a polling engine, this requires a properly configured device in the DDS with at least one corresponding data group: FMS Legacy Configuration (alarms) or FMS Alarms. This property is optional. |
When you are done, click Next > to access the Time dialog box.
When the Chromatograph Properties are complete, configure the Time properties.
Note: For devices belonging to a station, these settings must match. All Nodes belonging to the same station must have exactly the same time property settings configured, in order for data to roll up successfully to the station level.
Enter or verify the following time properties for the new Chromatograph Node.
| Property | Description |
|---|---|
|
Contract offset |
Type the number (in hours) of the contract hour offset. This number is synonymous with the Contract time. It is an offset (in hours) from the Device time, describing the hour at which the contract day begins. |
|
Time zone |
Click to select the desired time zone from the drop-down menu. Note: Edits to this property can only be applied for the entire span of the Node. An error message will appear if you try to edit this value for a partial span. |
|
Enable daylight saving |
Click to enable an adjustment for daylight saving time. Notes:
|
| Internal time configuration | |
|
CygNet Key |
An internal CygNet identifier Each time zone is assigned a unique numerical key in the CygNetTimeZones.xml file, located in the CygNet\Services\ARS folder on your host server. This property is read-only. Note: This value requires a properly installed CygNetTimeZones.xml file. See CygNetTimeZones.xml File for more information. |
|
Base bias from UTC |
The offset in hours between the device's expected time and Coordinated Universal Time (UTC) (also known as Greenwich Mean Time or GMT) This property is read-only. |
|
Standard time bias |
The offset in hours from the base bias to account for standard time in the selected time zone This property is read-only. |
|
Standard time name |
The complete standard time zone name, for example Eastern Standard Time This property is read-only. |
|
Standard time begins |
The date that standard time begins, for example 1st Sun in Nov. This property is read-only. |
|
Daylight saving bias |
The offset in hours between standard time and daylight saving time This property is read-only. |
|
Daylight saving name |
The complete daylight saving time zone name. For example, Pacific Daylight Time This property is read-only. |
|
Daylight time begins |
The date that daylight saving time begins, for example 2nd Sunday in March This property is read-only. |
| Time comparison | |
|
Local computer current time |
The time of the client computer Do not alter the client computer's time; it may cause undesirable changes in your CygNet system. This property is read-only. |
|
Device expected time |
The time expected for the remote device This property is read-only. |
When you are done, click Next > to access the Frozen Config Items dialog box.
When the Time properties are complete, configure Frozen Config Items.
Select/clear configuration items for which to "freeze" values in the system.
| Property | Description |
|---|---|
|
Frozen? |
Each check box represents a configuration item. If the check box is selected, its value is "frozen" so new configuration records won’t update the system. The raw data is still stored, however. Click the check box adjacent to any configuration item(s) you choose to select/clear whether or not to "freeze" its value. |
|
Config Item Desc |
Lists the descriptions of the configuration items for the selected meter. |
When you are done, click Finish to access the Save FMS Record dialog box.
Once the new Chromatograph Node properties are configured, you'll be asked to save your changes via the Save FMS Record dialog box. Configure the date and audit information requested to historize the changes in your system.
Specify the following parameters to describe the saved record.
| Property | Description |
|---|---|
|
Change begin |
Set the effective date and time for the record change to begin. Options are as follows.
|
|
Change end |
Note: Upon Node creation, this date selection is automatically set to Indefinite. Options become available for edits made to Node properties. |
|
Audit category |
Select an appropriate Audit category from the drop-down menu. The audit category type for Node creation is Configuration Change. Audit categories are configured on the Admin menu. See Configuring Audit Categories for more information. |
|
Comments |
Type Comments regarding creation of the Node in the text box. Although comments are optional, they become part of the record and can be helpful when auditing or reviewing records. |
When all parameters are configured, click Save to save the new chromatograph settings.